Git and Github

Murray Logan

28 July 2024

Background

Required

  • RStudio or text editor

Version control

Version control

  • large space requirements
  • difficult to collaborate

Git

Git - overview

  • Git - is a distributed version control system
  • Git - stores snapshots of the filesystem
  • commits

  • The system consists of three trees:

Git - overview

Files can be in one of four states:

  • untracked

Git - overview

Files can be in one of four states:

  • untracked
  • staged

Git - overview

Files can be in one of four states:

  • untracked
  • staged
  • committed

Git - overview

Files can be in one of four states:

  • untracked
  • staged
  • committed
  • modified

Git - overview

Git - overview

Git in depth

Git - configuration

This is a once off action (per machine)

  • define who you are
git config --global user.name "Your name"
git config --global user.email "your_email@whatever.com"
  • Specify that the initial branch should be called main rather than master
git config --global init.defaultBranch main
  • Check these settings
git config --global --list
user.name=pcinereus
user.email=i.obesulus@gmail.com
init.defaultbranch=main

Git - configuration

Or within R (via the usethis package)

usethis::use_git_config(user.name='Your name',
               user.email='your_email@whatever.com',
               scope='user')
usethis::git_sitrep()

OR via the gert package

gert::git_config_global()

Git - new repository

mkdir ~/tmp/Test_repo
cd ~/tmp/Test_repo
git init

RStudio

R

library(usethis)
create_project(path='~/path/project_name', rstudio=TRUE)
use_git()

Git - adding content


Create a file (text, code etc)

  • those using R, call it analysis.R
x=seq(1, 10, len = 1)
y=40 * 2 + rnorm(10, 0, 5)
plot(x, y)



Otherwise, create any kind of file (in the folder we just created)

Git - adding content

Stage the changes (add)

git add <file(s)>

For example:

git add analysis.R

RStudio

gert::git_add('analysis.R')

Git - adding content

Git - .gitignore

RStudio

Examples

  • .RData all files ending in .RData
  • .pdf all files ending in .pdf
  • data/ the entire folder called data

Git - committing

git commit -m 'Initial commit'
[main (root-commit) a1a873c] Initial commit
 1 file changed, 3 insertions(+)
 create mode 100644 analysis.R
cd ~/tmp/Test_repo
git status
On branch main
nothing to commit, working tree clean
../resources/git-tikz --git-dir ~/tmp/Test_repo/.git --filename 10_pres_git_Test_repo1.tex
ls -la 
#mv 10_pres_git_Test_repo1.pdf resources/10_pres_git_Test_repo1.pdf
total 9512
drwxr-xr-x 6 runner docker    4096 Jul 28 04:13 .
drwxr-xr-x 9 runner docker    4096 Jul 28 04:12 ..
-rw-r--r-- 1 runner docker 9539405 Jul 28 04:12 01_introduction.html
-rw-r--r-- 1 runner docker    8475 Jul 27 22:17 01_introduction.qmd
drwxr-xr-x 3 runner docker    4096 Jul 28 04:12 01_introduction_cache
-rw-r--r-- 1 runner docker   52787 Jul 28 04:12 10_pres_git.qmd
-rw-r--r-- 1 runner docker   52916 Jul 28 04:12 10_pres_git.rmarkdown
-rw-r--r-- 1 runner docker    2835 Jul 28 04:13 10_pres_git_Test_repo1.log
-rw-r--r-- 1 runner docker    1435 Jul 28 04:13 10_pres_git_Test_repo1.tex
drwxr-xr-x 3 runner docker    4096 Jul 28 04:12 10_pres_git_cache
drwxr-xr-x 3 runner docker    4096 Jul 28 04:13 10_pres_git_files
-rw-r--r-- 1 runner docker    1396 Jul 27 04:36 Makefile
-rw-r--r-- 1 runner docker     660 Jul 28 04:13 git-draw.dot
-rw-r--r-- 1 runner docker     203 Jul 27 22:17 pres-style.css
drwxr-xr-x 2 runner docker    4096 Jul 28 04:13 resources
-rw-r--r-- 1 runner docker   33657 Jul 28 04:13 tikz2da01b343437.log